Skip to main content

List Policies

Route

/v2/policies

Description

Retrieve a list of policies based on the provided filters. Policies define enforcement actions for data protection and content inspection.

Method

GET

Inputs

ParameterTypeRequiredDescription
filters.ids[]array[string]NoList of policy IDs to filter by
filters.include_disabledbooleanNoWhether to include disabled policies in the results
filters.types[]array[string]NoList of policy types to filter by (data_protection, content_inspection)

Output

FieldTypeDescription
typestringAlways "policies"
sizeintegerNumber of policies returned
resourcesarray[Policy]Array of policy objects
errorsarray[Error]Any errors encountered

Policy Object Structure

FieldTypeDescription
idstringUnique policy identifier
typestringPolicy type (data_protection, content_inspection)
namestringHuman-readable name
descriptionstringDetailed description
severitystringSeverity level (informational, low, medium, high, critical)
disabledbooleanWhether the policy is disabled
selection_typestringHow datasets are selected (dataset, sensitivity)
dataset_idsarray[string]Specific dataset IDs (when selection_type is dataset)
dataset_sensitivitiesarray[integer]Sensitivity levels (when selection_type is sensitivity)
created_atstringCreation timestamp (ISO 8601)

Rate Limit

  • 60 requests per minute per API key
  • 5 concurrent requests per endpoint

Example Response

{
"type": "policies",
"size": 2,
"resources": [
{
"id": "policy-123",
"type": "data_protection",
"name": "Customer PII Protection",
"description": "Protect customer personal information",
"severity": "high",
"disabled": false,
"selection_type": "dataset",
"dataset_ids": ["dataset-456"],
"created_at": "2024-01-15T10:30:00Z"
},
{
"id": "policy-789",
"type": "content_inspection",
"name": "Financial Data Inspection",
"description": "Inspect financial content for compliance",
"severity": "critical",
"disabled": false,
"selection_type": "sensitivity",
"dataset_sensitivities": [4, 5],
"created_at": "2024-01-10T14:20:00Z"
}
],
"errors": []
}